<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/client_session.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">client_session.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2session_8hpp.html">ipc/session/session.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2detail_2client__session__impl_8hpp.html">ipc/session/detail/client_session_impl.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session.html">ipc::session</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">/**</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * Implements Session concept on the Client_app end: a Session_mv that first achieves PEER state by connecting</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * to an opposing Session_server via Client_session_mv::sync_connect().  See overview of Session hierarchy</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * in namespace ipc::session doc header; then come back here if desired.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> *</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * It is unusual to use Client_session_mv template directly.  If you do wish to set up a client-side session peer,</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * and you do not require SHM support, then use #Client_session alias template.  The client-specific API,</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * particularly ctor and sync_connect(), is in Client_session_mv and documented here.  The side-agnostic API --</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * active once PEER state is achieved -- is described by Session (concept) doc header and implemented concretely</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * by Session_mv which is our `public`, non-`virtual` super-class.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * If you do wish to set up a client-side session peer, but you *do* require SHM support, then use</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * shm::classic::Client_session or similar (for other SHM-provider(s)).  However #Client_session</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * (hence Client_session_mv to which it aliases) is its super-class, and until PEER state is reached its API</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * remains the only relevant API to use.  Once Client_session_mv::sync_connect() puts `*this` into PEER</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * state, super-class Session_mv (= Session concept) API continues to be relevant.  Also in PEER state</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * SHM-relevant additional API members (e.g., shm::classic::Session_mv::app_shm()) become of interest.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * Summary hierarchy:</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *   - Session_mv (Session concept impl)</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *   - ^-- Client_session_mv (adds sync_connect())</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *   - =alias= #Client_session (parameterizes by transport-configuring knobs = template params)</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *   - ^-- shm::classic::Session_mv</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *     (adds `session_shm()`...; suitable for transport::struc::Channel_base::Serialize_via_session_shm)</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *   - =alias= shm::classic::Client_session (parameterizes by aforementioned knobs = template params)</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * We may refer to Client_session_mv as #Client_session below; particularly since it is likeliest used in that</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * form by the user.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * ### How to use ###</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * Per the Session concept a #Client_session is open/capable of operation when in PEER state only.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * A #Client_session object is always in one of 2 states:</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *   - NULL.  In this state, the object is doing nothing; neither connected nor connecting.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> *   - PEER.  At this stage it exactly implements the Session concept.  See Session_mv.  Reminder:</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *     It is not possible to exit PEER state.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * To get from NULL state to PEER state: Use Session_server on the other side.  On this side construct</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * a #Client_session (always in NULL state) and invoke sync_connect() which will synchronously and non-blockingly try</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * to move to PEER state (mission accomplished).  If the connect fails, it will stay in NULL</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * state.  Being moved-from makes a `*this` as-if default-cted; therefore also moves to NULL state.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * Once in PEER state #Client_session simply follows Session concept semantics.  At this stage our super-class</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * Session_mv implements that concept in particular.  See either doc header (Session, Session_mv).</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * A related reminder:</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *   - sync_connect() or the opposing `async_accept()` or both may optionally specify that 1+ *init-channels*</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *     be opened before this and the opposing Session is in PEER state and emitted to user.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> *     This may be a sufficient replacement of, or complementary to, active-open/passive-open APIs available</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> *     once the Session is in PEER state/emitted to user.  If not sufficient:</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> *   - Either side (being a Session_mv = Session) has open_channel(), and hence either side can accept passive-opens</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *     when the opposing side invokes open_channel().</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *   - However it is possible to configure either side to not accept passive-opens; meaning to be useful</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *     such a side shall be exclusively doing open_channel() (active-opens).  One might conclude, then, that</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *     #Server_session should be passive-opening, while #Client_session should be active-opening.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> *     That is *not* the case.  In PEER state established on both sides, the 2 sides are identical in this</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> *     respect.  If both sides are configured to accept passive-opens, then there&#39;s no question.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> *     If one side is so configured, it can be either side.  If both sides are so configured, the session is useless,</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> *     as every open_channel() will fail (unless one has set up init-channels).</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> *     - In #Client_session, one specifies the on-passive-open handler in ctor; to disable passive-opens use</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *       the ctor that omits that handler.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * ### Why no async-connect method, only sync-connect? ###</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * Without networking, the other side (Session_server) either exists/is listening; or no.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * Connecting is a synchronous, non-blocking operation; so an `async_connect()` API in this context only makes</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * life harder for the user.  (However, there are some serious plans to add a networking-capable counterpart</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * (probably via TCP at least) to `Native_socket_stream` and therefore Client_session_mv; such a networky-client-session</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * class will almost certainly have an `async_connect()`, while its `sync_connect()` will probably become potentially</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * blocking.)</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * @note Impl detail for exposition purposes: transport::Native_socket_stream is used internally by ipc::session</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *       to establish internal session-related IPC.  That is a Unix domain socket: local stream connection.  This can be</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> *       extended, relatively cheaply in terms of effort, to work over networked-TCP sockets.  Based on that work,</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *       Client_session and Session_server hierarchies can be relatively cheaply extended to also be network-enabled in</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *       some form.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * @note If some form of `*this` becomes network-enabled, open_channel() too will need an async form most likely,</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *       while existing open_channel() would become potentially-blocking.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * ### Thread safety and handler invocation semantics ###</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * These follow the Session concept policies.</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"></span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * ### Error handling ###</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * Once in PEER state, error handling follows the Session concept (= Session_mv concrete class) doc header.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * Up to that point (in NULL state) there are no public asynchronous operations; there is just sync_connect() which</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * succeeds or fails synchronously and quickly.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * ### Implementation design/rationale ###</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * Session_mv is the highest (`public`) super-class and begins the pImpl-lite-for-movability technique.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * It pImpl-wraps the Session-concept impl methods/stuff.  Client_session_mv merely repeats the same</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * technique but on the API additions at its own level; in particular the `explicit` ctors and</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * especially sync_connect().</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * The impl object is available via Session_mv::impl() (which is `protected`).  What type does this object</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * have though?  Answer: `Client_session_impl_t`, our template param!  This shall be the proper `..._impl`</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * internal-use type that matches the level of API (`public` sub-class) the user chose:  E.g.:</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *   - Chose #Client_session =&gt; impl = Client_session_impl.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *   - Chose shm::classic::Client_session =&gt; impl = shm::classic::Client_session_impl.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> * So basically each of the public-API types visible to the user adds the pImpl-wrapping of the methods</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * of the `..._impl` type matching their name; and the public/movable-API hierarchy has a parallel</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * internal/non-movable hierarchy, both using `public`/non-`virtual` inheritance.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * @see Client_session_impl doc header.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * @endinternal</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> *</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> * @see Session: implemented concept.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> * @tparam Client_session_impl_t</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> *         An implementation detail.  Use one of the aliases prescribed near the top of this doc header to</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *         set this correctly.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> */</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Client_session_impl_t&gt;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html">  143</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Client__session__mv.html">Client_session_mv</a> :</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>  <span class="keyword">public</span> <a class="code hl_class" href="classipc_1_1session_1_1Session__mv.html">Session_mv</a>&lt;Client_session_impl_t&gt;</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>{</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"></span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">  /// Short-hand for our base class.  To the user: note its `public` API is inherited.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#aaa2fa231533e672f89dd3ae63113d2a2">  150</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1Session__mv.html">Base</a> = <a class="code hl_class" href="classipc_1_1session_1_1Session__mv.html">Session_mv&lt;Client_session_impl_t&gt;</a>;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"></span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">  /// Inherit all ctors from Session_mv (default, move).</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"></span>  <span class="keyword">using </span>Base::Base;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"></span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">   * Constructs (passive-opens allowed form) in NULL state.  To be useful, invoke sync_connect() next.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">   *</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">   *        Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">   * @param cli_app_ref</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">   *        Properties of this client application.  The address is copied; the object is not copied.</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">   *        Properties of the opposing server application.  The address is copied; the object is not copied.</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">   * @param on_err_func</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">   *        On-error handler.  See Session concept doc header for semantics.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">   * @param on_passive_open_channel_func</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">   *        On-passive-open handler.  See Session concept doc header for semantics.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">   * @tparam On_passive_open_channel_handler</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment">   *         See Session concept doc header for semantics.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment">   * @tparam Task_err</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">   *         See Session concept doc header for semantics.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">   */</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> On_passive_open_channel_handler, <span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1Client__session__mv.html#af1341c2f02d27a766996639edd32dfa8">Client_session_mv</a>(flow::log::Logger* logger_ptr,</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>                             <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; cli_app_ref, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>                             Task_err&amp;&amp; on_err_func,</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>                             On_passive_open_channel_handler&amp;&amp; on_passive_open_channel_func);</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"></span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">   * Constructs (passive-opens disallowed form) in NULL state.  To be useful, invoke sync_connect() next.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment">   *</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">   *        Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   * @param cli_app_ref</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">   *        Properties of this client application.  The address is copied; the object is not copied.</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">   *        Properties of the opposing server application.  The address is copied; the object is not copied.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">   * @param on_err_func</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">   *        On-error handler.  See Session concept doc header for semantics.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   * @tparam Task_err</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   *         See Session concept doc header for semantics.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">   */</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1Client__session__mv.html#af1341c2f02d27a766996639edd32dfa8">Client_session_mv</a>(flow::log::Logger* logger_ptr,</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>                             <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; cli_app_ref, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span>                             Task_err&amp;&amp; on_err_func);</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span> </div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="preprocessor">#ifdef IPC_DOXYGEN_ONLY </span><span class="comment">// Actual compilation will ignore the below; but Doxygen will scan it and generate docs.</span><span class="comment"></span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   * Implements Session API per contract; plus usable to generate blank `mdt` argument for advanced</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   * sync_connect() overload.  That is: can additionally be invoked in NULL state (before sync_connect() or</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   * between a failed attempt and the next attempt).  The return value can be used only as follows; otherwise</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * undefined behavior results:</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   *   - If invoked in NULL state: pass to sync_connect().</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   *   - If invoked in PEER state: pass to open_channel().</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   *</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   *</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   * @see Session::mdt_builder(): implemented concept.</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#aba3aa4758c635339289d66be45df343b">  215</a></span>  <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#a787253f02859ea6b99ce3eba92766431">Mdt_builder_ptr</a> <a class="code hl_function" href="classipc_1_1session_1_1Client__session__mv.html#aba3aa4758c635339289d66be45df343b">mdt_builder</a>();</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="preprocessor">#endif </span><span class="comment">// IPC_DOXYGEN_ONLY</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"></span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   * To be invoked in NULL state only, and not as-if default-cted, it synchronously and non-blockingly attempts to</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   * connect to an opposing `Session_server`; and synchronously reports failure or success, the latter</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   * showing `*this` has entered PEER state.  Failure means `*this` remains in NULL state.</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   *</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   * If invoked outside of NULL state, or if it is as-if default-cted (i.e., default-cted or moved-from),</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   * this returns `false` and otherwise does nothing.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   *</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   * Note that `*this` (modulo moves) that has entered PEER state can never change state subsequently</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   * (even on transmission error); once a PEER, always a PEER.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   *</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">   * ### How does it know &quot;where&quot; the Session_server is listening? ###</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   * While details are internal, abstractly speaking this is determined by the Server_app passed to the ctor.</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   * Internal detail (for exposition/general knowledge):</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   *   - The server application maintains a *CNS* (Current Namespace Store, a/k/a PID) file.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   *     Only at most 1 server *instance* (a/k/a process) shall be active at a time.  The CNS contents --</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   *     which are simply the active server app process&#39;s PID -- determine &quot;where&quot; this `Client_session`</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   *     will connect, and all other internally used cross-process resources</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   *     (sockets, MQs, SHM pools...) are similarly segregated among different instances of the Server_app-described</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   *     application.</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   *   - The location of this file is determined by Server_app contents.  Namely, Server_app::m_name, at least,</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   *     is unique per Server_app in the universe, and most of the PID file&#39;s name comprises it; and</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   *     its location comprises Server_app::m_kernel_persistent_run_dir_override and/or /var/run (or equivalent).</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   *   - sync_connect() reads the CNS (PID) file at that location, unique among `Server_app`s.  Now it knows</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   *     &quot;where&quot; to connect in order to open the session; so it won&#39;t accidentally connect to some old zombie</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   *     instance of the Server_app (its PID wouldn&#39;t be in the CNS file any longer) or another application entirely</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   *     (its PID file would be located elsewhere and never accessed by this sync_connect()).</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   *</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   * ### What if the CNS (PID) file does not exist?  What if server is inactive? ###</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   * Then sync_connect() will quickly fail (file-not-found or connection-refused error).  Shouldn&#39;t we supply some</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   * API to await its appearance and actively listening?  Answer: Probably not.  Why? </span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   * Answer: Consider the situation where the PID file is there, but</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   * it belongs to a now-exited instance of the Server_app; let&#39;s say it is currently suspended or restarting.</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * sync_connect() will fail then too: There is nothing listening (anymore) at the advertised PID.  So</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * it&#39;ll quickly fail (connection-refused error).  So then we&#39;d also need an API to await an active server&#39;s</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * appearance whether or not the PID exists.  That leads to the following to-do:</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   *</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * @todo Consider adding an optional mode/feature to allow to wait through the condition wherein CNS (PID) file does</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   * not exist, or it does but the initial session-open connect op would be refused; instead it detects these relatively</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * common conditions (server not yet up and/or is restarting and/or is operationally suspended for now, etc.) as</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * normal and waits until the condition is cleared.  Without this mode, a typical user would probably do</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * something like: oh, sync_connect() failed; let&#39;s sleep 1 sec and try again (rinse/repeat).  It&#39;s not</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   * awful, but we might as well make it easier and more responsive out of the box (optionally).  Upon resolving this</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   * to-do please update the Manual section @ref session_setup accordingly.</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">   *</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   * @see Class doc header, section &quot;Why no async-connect method, only sync-connect?&quot; for potentially interesting</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   *      context.</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   *</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * @return `false` if and only if invoked outside of NULL state; or if `*this` is as-if default-cted.</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   *</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   *        session::error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER (destructor called, canceling all pending ops;</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment">   *        spiritually identical to `boost::asio::error::operation_aborted`),</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment">   *        interprocess-mutex-related errors (probably from boost.interprocess) w/r/t reading the CNS (PID file),</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">   *        file-related system errors w/r/t reading the CNS (PID file) (see Session_server doc header for background),</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   *        error::Code::S_CLIENT_NAMESPACE_STORE_BAD_FORMAT (bad CNS contents),</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   *        those emitted by transport::Native_socket_stream::sync_connect(),</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   *        those emitted by transport::struc::Channel::send(),</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   *        those emitted by transport::struc::Channel via on-error handler (most likely</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   *        transport::error::Code::S_RECEIVES_FINISHED_CANNOT_RECEIVE indicating graceful shutdown of opposing process</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   *        coincidentally during log-in procedure, prematurely ending session while it was starting),</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   *        error::Code::S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD,</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   *        error::Code::S_INVALID_ARGUMENT (other side expected other sync_connect() overload with</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *        non-null `init_channels_by_srv_req` arg).</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   */</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1session_1_1Client__session__mv.html#ab971ea979200828d572638c60d7d9f44">sync_connect</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment"></span> </div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   * Identical to the simpler sync_connect() overload but offers added advanced capabilities: metadata exchange;</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * initial-channel opening.  The other overload is identical to</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * `sync_connect(mdt_builder(), nullptr, nullptr, nullptr, err_code)` and requires</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * the opposing `async_accept()` to similarly not use the corresponding features.</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   *</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * ### Client-&gt;server metadata exchange ###</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * Client may wish to provide information in some way, but without a structured channel -- or any channel -- yet</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   * available, this provides an opportunity to do so in a structured way with a one-off message available at</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * session open, together with the opposing Session object itself.</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   *</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * Similarly to how it is optionally done on a per-channel-open basis (open_channel()): call `mdt = mdt_builder()`;</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * fill out the resulting capnp structure `*mdt`; then pass `mdt` to sync_connect().  Opposing `async_accept()` shall</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * receive deserializable `Mdt_reader` together with the freshly-opened Session, though they may choose to ignore it.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   *</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   * To omit using this feature, skip the &quot;fill out the resulting capnp structure&quot; step.  You must still</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * call mdt_builder() and pass-in the result.  (The other overload does so.)</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   *</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * ### Server-&gt;client metadata exchange ###</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   * This is the reverse of the above.  Whatever the opposing server chose to supply as server-&gt;client metadata</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   * shall be deserializable at `*mdt_from_srv_or_null` on successful return from `sync_connect()`.</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   * If `mdt_from_srv_or_null` is null, the srv-&gt;cli metadata shall be ignored.</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   *</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   * ### Init-channels by client request ###</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   * Once the session is open, open_channel() and the on-passive-open handler may be used to open channels at will.</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   * In many use cases, however, a certain number of channels is required immediately before work can really begin</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * (and, frequently, no further channels are even needed).  For convenience (to avoid asynchrony/boiler-plate)</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   * the init-channels feature will pre-open a requested # of channels making them available right away, together</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   * with the freshly-open session -- to both sides.</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   *</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   * The client may request 0 or more init-channels.  They shall be opened and placed into</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * `*init_channels_by_cli_req_pre_sized`; its `-&gt;size()` at entry to the method indicates the number of channels</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   * requested.  If null, it is treated as if `-&gt;size() == 0`, meaning no init-channels-by-client-request are opened.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   *</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   * ### Init-channels by server request ###</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   * This is the reverse of the above.  The opposing side shall request 0 or more init-channels-by-server-request;</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * that number of channels shall be opened; and they will be placed into `*init_channels_by_srv_req` which shall</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   * be `-&gt;resize()`d accordingly on successful return from `sync_connect()`.</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   *</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   * `init_channels_by_srv_req` being null is allowed, but only if the opposing server requests 0</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   * init-channels-by-server-request.  Otherwise an error shall be emitted (see below).</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   *</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   * @param mdt</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   * @param init_channels_by_cli_req_pre_sized</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *        See above: null or pointer to container of `Channel_obj` with `.size()` specifying how many channels</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   *        this side is requesting to be opened on its behalf; each element will be move-assigned</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *        a PEER-state `Channel_obj` on success.  Recommend simply ct-ing with `(n)` or `.resize(n)` which</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *        loads it with default-cted (NULL-state) objects to be replaced.  null is treated same as</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   *        `.empty()`.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   * @param mdt_from_srv_or_null</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   *        See above: null or pointer to `Reader` of metadata which shall be set for access on success.</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   * @param init_channels_by_srv_req</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   *        See above: null or pointer to container of `Channel_obj` which shall be `.clear()`ed and replaced</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   *        by a container of PEER-state `Channel_obj` on success the number being specified by the opposing</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   *        (server) side.  The number may be zero.  null is allowed if and only if the number is zero;</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   *        otherwise error::Code::S_INVALID_ARGUMENT is emitted.</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   *        See other sync_connect() overload.  Note the above target (pointer) args are touched</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   *        only if no error is emitted via this standard Flow error reporting mechanism.</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   * @return See other sync_connect() overload.</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   */</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1session_1_1Client__session__mv.html#ab971ea979200828d572638c60d7d9f44">sync_connect</a>(<span class="keyword">const</span> <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#a787253f02859ea6b99ce3eba92766431">Base::Mdt_builder_ptr</a>&amp; mdt,</div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>                    <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#af87da439644b2afd73d6a13d97e7985f">Base::Channels</a>* init_channels_by_cli_req_pre_sized = 0,</div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span>                    <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#a2b1215fb0c9738b9fcfbb337d23c43df">Base::Mdt_reader_ptr</a>* mdt_from_srv_or_null = 0,</div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span>                    <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#af87da439644b2afd73d6a13d97e7985f">Base::Channels</a>* init_channels_by_srv_req = 0,</div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span>                    <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span> </div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span> </div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span>  <span class="comment">// The LOG_*() macros don&#39;t see Log_context::get_log*() from base otherwise....</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span>  <span class="keyword">using </span><a class="code hl_function" href="classipc_1_1session_1_1Session__mv.html#a142df6d6db09962a1dc0f536bf4977f0">Base::get_logger</a>;</div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span>  <span class="keyword">using </span><a class="code hl_function" href="classipc_1_1session_1_1Session__mv.html#a23b43187319871c4974755175973008e">Base::get_log_component</a>;</div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span>}; <span class="comment">// class Client_session_mv</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span> </div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span> </div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment"></span> </div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno"><a class="line" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">  366</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_CLI_SESSION_MV \</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="preprocessor">  template&lt;typename Client_session_impl_t&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno"><a class="line" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#af3f8dc4ce7bb5480a5515107b96f4f20">  369</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_CLI_SESSION_MV \</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="preprocessor">  Client_session_mv&lt;Client_session_impl_t&gt;</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span> </div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">// The rest is strict forwarding to impl() (when not null).</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span> </div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">TEMPLATE_CLI_SESSION_MV</a></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> On_passive_open_channel_handler, <span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#af1341c2f02d27a766996639edd32dfa8">  376</a></span>CLASS_CLI_SESSION_MV::Client_session_mv</div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span>  (flow::log::Logger* logger_ptr,</div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span>   <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; cli_app_ref, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span>   Task_err&amp;&amp; on_err_func,</div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span>   On_passive_open_channel_handler&amp;&amp; on_passive_open_channel_func_or_empty_arg)</div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>{</div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>  Base::impl()</div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span>    = boost::movelib::make_unique&lt;Client_session_impl_t&gt;(logger_ptr, cli_app_ref, srv_app_ref,</div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span>                                                         std::move(on_err_func),</div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>                                                         std::move(on_passive_open_channel_func_or_empty_arg));</div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span>}</div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span> </div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">TEMPLATE_CLI_SESSION_MV</a></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#a2c1a00a343a70a31cb630969138b6b25">  390</a></span>CLASS_CLI_SESSION_MV::Client_session_mv(flow::log::Logger* logger_ptr,</div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>                                        <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; cli_app_ref, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span>                                        Task_err&amp;&amp; on_err_func)</div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span>{</div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span>  Base::impl()</div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span>    = boost::movelib::make_unique&lt;Client_session_impl_t&gt;(logger_ptr, cli_app_ref, srv_app_ref,</div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span>                                                         std::move(on_err_func));</div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span>}</div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span> </div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">TEMPLATE_CLI_SESSION_MV</a></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#ab971ea979200828d572638c60d7d9f44">  400</a></span><span class="keywordtype">bool</span> CLASS_CLI_SESSION_MV::sync_connect(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span>{</div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span>  <span class="keywordflow">return</span> Base::impl() ? Base::impl()-&gt;sync_connect(err_code) : <span class="keyword">false</span>;</div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span>}</div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span> </div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">TEMPLATE_CLI_SESSION_MV</a></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#a350e1a338a6874ce30f13345edad742a">  406</a></span><span class="keywordtype">bool</span> CLASS_CLI_SESSION_MV::sync_connect(<span class="keyword">const</span> <span class="keyword">typename</span> Base::Mdt_builder_ptr&amp; mdt,</div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span>                                        <span class="keyword">typename</span> Base::Channels* init_channels_by_cli_req_pre_sized,</div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span>                                        <span class="keyword">typename</span> Base::Mdt_reader_ptr* mdt_from_srv_or_null,</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span>                                        <span class="keyword">typename</span> Base::Channels* init_channels_by_srv_req,</div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span>                                        <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span>{</div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span>  <span class="keywordflow">return</span> Base::impl()</div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span>           ? Base::impl()-&gt;sync_connect(mdt, init_channels_by_cli_req_pre_sized,</div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span>                                        mdt_from_srv_or_null, init_channels_by_srv_req, err_code)</div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span>           : <span class="keyword">false</span>;</div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span>}</div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span> </div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">TEMPLATE_CLI_SESSION_MV</a></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Client__session__mv.html#a8a2e780e6c5266b8c2e4207d7e256afe">  419</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_define" href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#af3f8dc4ce7bb5480a5515107b96f4f20">CLASS_CLI_SESSION_MV</a>&amp; val)</div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span>{</div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span>  <span class="keywordflow">return</span> os &lt;&lt; static_cast&lt;const typename CLASS_CLI_SESSION_MV::Base&amp;&gt;(val);</div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span>}</div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span> </div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="preprocessor">#undef CLASS_CLI_SESSION_MV</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="preprocessor">#undef TEMPLATE_CLI_SESSION_MV</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span> </div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span>} <span class="comment">// namespace ipc::session</span></div>
<div class="ttc" id="aclassipc_1_1session_1_1Client__session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Client__session__mv.html">ipc::session::Client_session_mv</a></div><div class="ttdoc">Implements Session concept on the Client_app end: a Session_mv that first achieves PEER state by conn...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2client__session_8hpp_source.html#l00143">client_session.hpp:145</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Client__session__mv_html_ab971ea979200828d572638c60d7d9f44"><div class="ttname"><a href="classipc_1_1session_1_1Client__session__mv.html#ab971ea979200828d572638c60d7d9f44">ipc::session::Client_session_mv::sync_connect</a></div><div class="ttdeci">bool sync_connect(Error_code *err_code=0)</div><div class="ttdoc">To be invoked in NULL state only, and not as-if default-cted, it synchronously and non-blockingly att...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2client__session_8hpp_source.html#l00400">client_session.hpp:400</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Client__session__mv_html_aba3aa4758c635339289d66be45df343b"><div class="ttname"><a href="classipc_1_1session_1_1Client__session__mv.html#aba3aa4758c635339289d66be45df343b">ipc::session::Client_session_mv::mdt_builder</a></div><div class="ttdeci">Mdt_builder_ptr mdt_builder()</div><div class="ttdoc">Implements Session API per contract; plus usable to generate blank mdt argument for advanced sync_con...</div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Client__session__mv_html_af1341c2f02d27a766996639edd32dfa8"><div class="ttname"><a href="classipc_1_1session_1_1Client__session__mv.html#af1341c2f02d27a766996639edd32dfa8">ipc::session::Client_session_mv::Client_session_mv</a></div><div class="ttdeci">Client_session_mv(flow::log::Logger *logger_ptr, const Client_app &amp;cli_app_ref, const Server_app &amp;srv_app_ref, Task_err &amp;&amp;on_err_func, On_passive_open_channel_handler &amp;&amp;on_passive_open_channel_func)</div><div class="ttdoc">Constructs (passive-opens allowed form) in NULL state.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2client__session_8hpp_source.html#l00376">client_session.hpp:377</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html">ipc::session::Session_mv</a></div><div class="ttdoc">Implements the Session concept when it is in PEER state.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00504">session.hpp:505</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_a142df6d6db09962a1dc0f536bf4977f0"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#a142df6d6db09962a1dc0f536bf4977f0">ipc::session::Session_mv&lt; Client_session_impl_t &gt;::get_logger</a></div><div class="ttdeci">flow::log::Logger * get_logger() const</div><div class="ttdoc">Returns logger (possibly null).</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00786">session.hpp:932</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_a23b43187319871c4974755175973008e"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#a23b43187319871c4974755175973008e">ipc::session::Session_mv&lt; Client_session_impl_t &gt;::get_log_component</a></div><div class="ttdeci">const flow::log::Component &amp; get_log_component() const</div><div class="ttdoc">Returns log component.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00792">session.hpp:938</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_a2b1215fb0c9738b9fcfbb337d23c43df"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#a2b1215fb0c9738b9fcfbb337d23c43df">ipc::session::Session_mv&lt; Client_session_impl_t &gt;::Mdt_reader_ptr</a></div><div class="ttdeci">typename Impl::Mdt_reader_ptr Mdt_reader_ptr</div><div class="ttdoc">Implements Session API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00546">session.hpp:546</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_a787253f02859ea6b99ce3eba92766431"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#a787253f02859ea6b99ce3eba92766431">ipc::session::Session_mv&lt; Client_session_impl_t &gt;::Mdt_builder_ptr</a></div><div class="ttdeci">typename Impl::Mdt_builder_ptr Mdt_builder_ptr</div><div class="ttdoc">Implements Session API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00540">session.hpp:540</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_af87da439644b2afd73d6a13d97e7985f"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#af87da439644b2afd73d6a13d97e7985f">ipc::session::Session_mv&lt; Client_session_impl_t &gt;::Channels</a></div><div class="ttdeci">typename Impl::Channels Channels</div><div class="ttdoc">Container (vector&lt;&gt;) of Channel_obj.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00522">session.hpp:522</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2client__session_8hpp_html_a2e1779452d3b1f2df4122ac09ceab2ea"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#a2e1779452d3b1f2df4122ac09ceab2ea">TEMPLATE_CLI_SESSION_MV</a></div><div class="ttdeci">#define TEMPLATE_CLI_SESSION_MV</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2client__session_8hpp_source.html#l00366">client_session.hpp:366</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2client__session_8hpp_html_af3f8dc4ce7bb5480a5515107b96f4f20"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2client__session_8hpp.html#af3f8dc4ce7bb5480a5515107b96f4f20">CLASS_CLI_SESSION_MV</a></div><div class="ttdeci">#define CLASS_CLI_SESSION_MV</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2client__session_8hpp_source.html#l00369">client_session.hpp:369</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2detail_2client__session__impl_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2detail_2client__session__impl_8hpp.html">client_session_impl.hpp</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2session_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2session_8hpp.html">session.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html"><div class="ttname"><a href="namespaceipc_1_1session.html">ipc::session</a></div><div class="ttdoc">Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00026">app.cpp:27</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a6b2f9a90ac9cc5098d9b90e7f547c97e"><div class="ttname"><a href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">ipc::session::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const App &amp;val)</div><div class="ttdoc">Prints string representation of the given App to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00124">app.cpp:124</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Client__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Client__app.html">ipc::session::Client_app</a></div><div class="ttdoc">An App that is used as a client in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00184">app.hpp:185</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
